/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.kairos.utils.monitor
{
	import com.bourre.structures.Range;
	import com.kairos.engine.RTEvent;
	
	/**
	 * The <code>StepField</code> measure the current time step
	 * of an animation. 
	 * 
	 * @author 	Cédric Néhémie
	 * @see		AbstractMonitorField
	 * @see		MonitorField
	 */
	public class StepField extends AbstractMonitorField implements MonitorField
	{
		
		/**
		 * Create a new <code>StepField</code> object to add in the <code>Monitor</code>.
		 * 
		 * @param col	<code>Number</code> color of the field. 
		 * @param dr	<code>Range</code> of values supported in display.
		 */
		public function StepField( dr : Range = null, col : Number = NaN )
		{
			super( "Step" , 0, "ms", dr, col );
		}
		
		/**
		 * Registers the current time step dispatched by the <code>RTBeacon</code>.
		 * 
		 * @param	e	<code>RTEvent</code> dispatched by the <code>RTBeacon</code>
		 */
		public override final function registerValue ( e : RTEvent ) : void
		{
			_nLastValue = _nValue;
			_nValue = Math.round( e.getStep() );
		}
	}
}